This resource address returns the modifiable properties of the named database.
The database can be identified either by id or name.
Upon success, MarkLogic Server returns status code 200 (OK). A status code of
401 (Unauthorized) is returned if the user does not have the necessary privileges.
database-name
The database name.
enabled
Database enabled status.
security-database
The security database.
schema-database
The database that contains schemas.
triggers-database
The database that contains triggers.
data-encryption
Enable encryption at rest for this database
backup-encryption-key
Defines which KEK will be used for the database backup.
encryption-key-id
The identifier of the user data encryption key at the KMS.
forests
The forests of a database.
This is a complex structure with the following children:
forest
The unique id of the forest.
subdatabases
The subdatabases of a database.
This is a complex structure with the following children:
subdatabase
The name of a subdatabase.
This is a complex structure with the following children:
cluster-name
The name of a cluster.
database-name
The database name.
retired-forests
The retired forests of a database.
This is a complex structure with the following children:
retired-forest
The name of a retired forest.
retired-forest-count
The number of retired forests in a database.
language
The default language assumed for content (if xml:lang encoding is absent)
stemmed-searches
Enable stemmed word searches
(slower document loads and larger database files).
word-searches
Enable unstemmed word searches
(slower document loads and larger database files).
word-positions
Index word positions
for faster phrase and near searches
(slower document loads and larger database files).
fast-phrase-searches
Enable faster phrase searches
(slower document loads and larger database files).
fast-reverse-searches
Enable faster reverse searches
(slower document loads and larger database files).
triple-index
Enable the RDF triple index
(slower document loads and larger database files).
triple-positions
Index triple positions
for faster near searches involving cts:triple-range-query
(slower document loads and larger database files).
fast-case-sensitive-searches
Enable faster case sensitive searches
(slower document loads and larger database files).
fast-diacritic-sensitive-searches
Enable faster diacritic sensitive searches
(slower document loads and larger database files).
fast-element-word-searches
Enable faster element-word searches
(slower document loads and larger database files).
element-word-positions
Index element word positions
for faster element-based phrase and near searches
(slower document loads and larger database files).
fast-element-phrase-searches
Enable faster element phrase searches
(slower document loads and larger database files).
element-value-positions
Index element value positions
for faster near searches involving element-value-query
(slower document loads and larger database files).
attribute-value-positions
Index attribute value positions
for faster near searches involving element-attribute-value-query
(slower document loads and larger database files).
field-value-searches
Index field values
for faster searches involving field-value-query
(slower document loads and larger database files).
field-value-positions
Index field value positions
for faster near searches involving field-value-query
(slower document loads and larger database files).
three-character-searches
Enable wildcard searches
and faster character-based XQuery predicates
using three or more characters
(slower document loads and larger database files).
three-character-word-positions
Index word positions
for three-character searches
only when three-character-searches are enabled
(slower document loads and larger database files).
fast-element-character-searches
Enable element wildcard searches
and element-character-based XQuery predicates
(slower document loads and larger database files).
trailing-wildcard-searches
Enable trailing wildcard searches
(slower document loads and larger database files).
trailing-wildcard-word-positions
Index word positions
for trailing-wildcard searches
only when trailing-wildcard-searches are enabled
(slower document loads and larger database files).
fast-element-trailing-wildcard-searches
Enable element trailing wildcard searches
(slower document loads and larger database files).
word-lexicons
A list of word lexicons. Each lexicon is defined by its collation uri.
This is a complex structure with the following children:
word-lexicon
Maintain a lexicon of words (slower document loads and larger
database files).
two-character-searches
Enable wildcard searches
and faster character-based XQuery predicates
using two character
(slower document loads and larger database files).
one-character-searches
Enable wildcard searches
and faster character-based XQuery predicates
using one character
(slower document loads and larger database files).
uri-lexicon
Maintain a lexicon of document URIs
(slower document loads and larger database files).
collection-lexicon
Maintain a lexicon of collection URIs
(slower document loads and larger database files).
reindexer-enable
Enable automatic reindexing after configuration changes.
reindexer-throttle
Larger numbers mean work harder at reindexing.
reindexer-timestamp
Reindex/refragment all fragments with timestamps less than or equal to
the timestamp specified. 0 means no forced reindexing.
directory-creation
Automatically (for WebDAV) or manually manage directories
maintain-last-modified
Maintain last-modified properties of documents.
maintain-directory-last-modified
Maintain last-modified properties of directories.
inherit-permissions
New document default permissions include parent directory permissions.
inherit-collections
New document default collections include parent directory collections.
inherit-quality
New document default quality is inherited parent directory quality.
in-memory-limit
The maximum number of fragments in an in-memory stand.
in-memory-list-size
Size of the in-memory list storage, in megabytes.
in-memory-tree-size
Size of the in-memory tree storage, in megabytes.
in-memory-range-index-size
Size of the in-memory range index storage, in megabytes.
in-memory-reverse-index-size
Size of the in-memory reverse index storage, in megabytes.
in-memory-triple-index-size
Size of the in-memory triple index storage, in megabytes.
in-memory-geospatial-region-index-size
Size of the in-memory geospatial region index storage, in megabytes.
triple-index-geohash-precision
The geohash precision for geometries stored in the triple index.
large-size-threshold
Size threshold for large objects, in kilobytes.
locking
Specifies how robust transaction locking should be.
journaling
Specifies how robust transaction journaling should be.
journal-size
Size of each journal file, in megabytes.
journal-count
The number of journal files.
preallocate-journals
Allocate journal files before executing transactions.
preload-mapped-data
Preload memory mapped forest information while mounting forest.
preload-replica-mapped-data
Preload memory mapped forest information while mounting replica forest.
range-index-optimize
Specifies how to optimize range indexes.
positions-list-max-size
Maximum size of a positions-containing list, in megabytes.
Lists longer than this have positions discarded.
format-compatibility
Version of on-disk forest format.
index-detection
Handling of differences between the current configuration of
database indexes and on-disk settings.
expunge-locks
Garbage collection of timed locks that have expired.
tf-normalization
What kind of TF normalization to apply.
merge-priority
The CPU scheduler priority for merges.
merge-max-size
Maximum allowable size (in megabytes) for merges,
or 0 for no limit.
merge-min-size
Stands with fewer than this number of fragments are merged together.
merge-min-ratio
Larger ratios trigger more merges.
merge-timestamp- The earliest system timestamp allowed for requests, or 0 to
indicate the timestamp corresponding to the time of latest merge.
Merges discard information about earlier timestamps.
- Entering a value of type xs:dateTime will have it automatically
converted to its corresponding timestamp.
- A negative value indicates a timestamp relative to
the time of the latest merge, at ten million ticks per second.
For example, -6000000000 means ten minutes before the latest merge.
- A value in red indicates that you have filled in the text
field with the current timestamp, but have not clicked ok to save the
value to your config file.
retain-until-backup
Retain deleted fragments until backup.
merge-blackouts
Periods during which merges will not occur.
This is a complex structure with the following children:
merge-blackout
A merge blackout specification.
This is a complex structure with the following children:
blackout-type
What type of blackout is this.
limit
Maximum allowable size (in megabytes) for merges
that occur during a blackout period, or 0 to disable
merges completely.
merge-priority
The CPU scheduler priority for merges.
days
The days that this blackout is active.
This is a complex structure with the following children:
day
A day that this blackout is active.
period
A period, which is all day, a start time and a duration, or a
start and end time.
This is a complex structure with the following children:
start-date
The starting date (in MM/DD/YYYY notation)
start-time
The starting time (in 24:00 notation).
end-date
The ending date (in MM/DD/YYYY notation)
end-time
The ending time (in 24:00 notation).
duration
The duration, specifed as hours:minutes (i.e. 2 hours 5 minutes is 2:05)
database-backups
Backups scheduled for this database.
This is a complex structure with the following children:
database-backup
A scheduled database backup.
This is a complex structure with the following children:
backup-id
The backup ID.
backup-enabled
Whether or not a backup is enabled
backup-directory
The backup directory pathname for this database.
Each database should use a different backup directory.
backup-kek-id
A Key Encryption Key (KEK) to use for backup encryption, the must valid
and be usable to encrypt and decrypt.
This field can only be provided when MarkLogic is configured with an external KMS.
backup-type
What type of backup is this.
backup-period
How often this backup should run (every n months, weeks, days, hours or minutes).
backup-month-day
The day of the month that this backup happens.
backup-days
The days that this backup happens.
This is a complex structure with the following children:
backup-day
A day that this backup occurs.
backup-start-date
The starting date (in MM/DD/YYYY notation) for this backup.
backup-start-time
The starting time (in 24:00 notation) for this backup.
backup-timestamp
The date and time this backup was created.
max-backups
The maximum number of full backups to keep in this backup directory (use 0 to disable backup deletions).
backup-schemas-database
Backup the schemas database for this database.
backup-security-database
Backup the security database for this database.
backup-triggers-database
Backup the triggers database for this database.
include-replicas
Backup the replica forests as well as the master forests.
journal-archiving
Is journal archiving enabled for a full backup?
journal-archive-path
Path to the associated journal archive location.
journal-archive-lag-limit
Number of seconds the archived journal can lag the active journal.
incremental-backup
Is this an incremental backup?
incremental-dir
Path to the incremental backup location.
purge-journal-archive
purge journal archive after an incremental backup
fragment-roots
The fragment root specifications.
This is a complex structure with the following children:
fragment-root
A fragment root specification.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
fragment-parents
The fragment parent specifications.
This is a complex structure with the following children:
fragment-parent
A fragment parent specification.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
element-word-query-throughs
The element-word-query-through specifications.
This is a complex structure with the following children:
element-word-query-through
Element-word-query matches may cross these markup boundaries.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
phrase-throughs
The phrase-through specifications.
This is a complex structure with the following children:
phrase-through
Phrases may cross these markup boundaries.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
phrase-arounds
The phrase-around specifications.
This is a complex structure with the following children:
phrase-around
Phrases may jump around these elements.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
range-element-indexes
Indexes for fast inequality comparisons.
This is a complex structure with the following children:
range-element-index
An index for fast element inequality comparisons.
This is a complex structure with the following children:
scalar-type
An atomic type specification.
namespace-uri
A namespace URI.
localname
One or more localnames.
collation
A collation URI for string comparisons.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
range-element-attribute-indexes
Indexes for fast element-attribute inequality comparisons.
This is a complex structure with the following children:
range-element-attribute-index
An index for fast element-attribute inequality comparisons.
This is a complex structure with the following children:
scalar-type
An atomic type specification.
parent-namespace-uri
A parent element namespace URI.
parent-localname
One or more parent element localnames.
namespace-uri
A namespace URI.
localname
One or more localnames.
collation
A collation URI for string comparisons.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
element-word-lexicons
Maintain lexicons of words in XML elements or JSON properties.
This is a complex structure with the following children:
element-word-lexicon
Maintain a lexicon of words in an XML element or a JSON property.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
collation
A collation URI for string comparisons.
element-attribute-word-lexicons
Maintain lexicons of words in elements.
This is a complex structure with the following children:
element-attribute-word-lexicon
Maintain a lexicon of words in an element attribute.
This is a complex structure with the following children:
parent-namespace-uri
A parent element namespace URI.
parent-localname
One or more parent element localnames.
namespace-uri
A namespace URI.
localname
One or more localnames.
collation
A collation URI for string comparisons.
path-namespaces
The namespace binding specifications for Path indexes.
This is a complex structure with the following children:
path-namespace
A namespace binding specification.
This is a complex structure with the following children:
prefix
A QName prefix.
namespace-uri
A namespace URI.
range-path-indexes
Indexes for fast inequality comparisons.
This is a complex structure with the following children:
range-path-index
An index for fast path inequality comparisons.
This is a complex structure with the following children:
scalar-type
An atomic type specification.
path-expression
The path expression.
For example:/prefix1:locname1/prefix2:locname2...
collation
A collation URI for string comparisons.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
fields
The fields specifications.
This is a complex structure with the following children:
field
The field specifications.
This is a complex structure with the following children:
field-name
The field name.
include-root
Includes XML elements or JSON properties starting at the document root.
field-path
The path in the field.
This is a complex structure with the following children:
path
The path expression.
For example:/prefix1:locname1/prefix2:locname2...
weight
The weight, used to boost or lower relevance scores.
metadatastemmed-searches
Enable stemmed word searches
(slower document loads and larger database files).
word-searches
Enable unstemmed word searches
(slower document loads and larger database files).
field-value-searches
Index field values
for faster searches involving field-value-query
(slower document loads and larger database files).
field-value-positions
Index field value positions
for faster near searches involving field-value-query
(slower document loads and larger database files).
fast-phrase-searches
Enable faster phrase searches
(slower document loads and larger database files).
fast-case-sensitive-searches
Enable faster case sensitive searches
(slower document loads and larger database files).
fast-diacritic-sensitive-searches
Enable faster diacritic sensitive searches
(slower document loads and larger database files).
trailing-wildcard-searches
Enable trailing wildcard searches
(slower document loads and larger database files).
trailing-wildcard-word-positions
Index word positions
for trailing-wildcard searches
only when trailing-wildcard-searches are enabled
(slower document loads and larger database files).
three-character-searches
Enable wildcard searches
and faster character-based XQuery predicates
using three or more characters
(slower document loads and larger database files).
three-character-word-positions
Index word positions
for three-character searches
only when three-character-searches are enabled
(slower document loads and larger database files).
two-character-searches
Enable wildcard searches
and faster character-based XQuery predicates
using two character
(slower document loads and larger database files).
one-character-searches
Enable wildcard searches
and faster character-based XQuery predicates
using one character
(slower document loads and larger database files).
word-lexicons
A list of word lexicons. Each lexicon is defined by its collation uri.
This is a complex structure with the following children:
word-lexicon
Maintain a lexicon of words (slower document loads and larger
database files).
included-elements
The XML elements or JSON properties included in the field.
This is a complex structure with the following children:
included-element
The XML element or JSON property included in the field.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
weight
The weight, used to boost or lower relevance scores.
attribute-namespace-uri
Namespace of the child attribute.
attribute-localname
Localname of the child attribute.
attribute-value
Include or Exclude only elements with the specified attribute having this value.
excluded-elements
The elements excluded from the field.
This is a complex structure with the following children:
excluded-element
The XML element or JSON property excluded from the field.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
attribute-namespace-uri
Namespace of the child attribute.
attribute-localname
Localname of the child attribute.
attribute-value
Include or Exclude only elements with the specified attribute having this value.
tokenizer-overrides
This is a complex structure with the following children:
tokenizer-override
This is a complex structure with the following children:
charactertokenizer-class
range-field-indexes
Indexes for fast inequality comparisons.
This is a complex structure with the following children:
range-field-index
An index for fast field inequality comparisons.
This is a complex structure with the following children:
scalar-type
An atomic type specification.
field-name
The field name.
collation
A collation URI for string comparisons.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
geospatial-element-indexes
Indexes for fast geospatial element comparisons.
This is a complex structure with the following children:
geospatial-element-index
Element value geospatial index. Element content has point value.
This is a complex structure with the following children:
namespace-uri
A namespace URI.
localname
One or more localnames.
coordinate-system
A coordinate system name.
point-format
The general format of the point.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
geospatial-element-child-indexes
Indexes for fast geospatial element comparisons.
This is a complex structure with the following children:
geospatial-element-child-index
Element child value geospatial index.
Child XML element or JSON property content has point value.
This is a complex structure with the following children:
parent-namespace-uri
A parent element namespace URI.
parent-localname
One or more parent element localnames.
namespace-uri
A namespace URI.
localname
One or more localnames.
coordinate-system
A coordinate system name.
point-format
The general format of the point.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
geospatial-element-pair-indexes
Indexes for fast geospatial element comparisons.
This is a complex structure with the following children:
geospatial-element-pair-indexElement pair geospatial index.
Point value is divided into latitude and longitude
in child XML element or JSON property content.
This is a complex structure with the following children:
parent-namespace-uri
A parent element namespace URI.
parent-localname
One or more parent element localnames.
latitude-namespace-uri
A latitude child namespace URI.
latitude-localname
One or more latitude child localnames.
longitude-namespace-uri
A longitude child namespace URI.
longitude-localname
One or more longitude child localnames.
coordinate-system
A coordinate system name.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
geospatial-element-attribute-pair-indexes
Indexes for fast geospatial element comparisons.
This is a complex structure with the following children:
geospatial-element-attribute-pair-indexAttribute pair geospatial index.
Point value is divided into latitude and longitudes in
attribute content.
This is a complex structure with the following children:
parent-namespace-uri
A parent element namespace URI.
parent-localname
One or more parent element localnames.
latitude-namespace-uri
A latitude child namespace URI.
latitude-localname
One or more latitude child localnames.
longitude-namespace-uri
A longitude child namespace URI.
longitude-localname
One or more longitude child localnames.
coordinate-system
A coordinate system name.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
geospatial-path-indexes
Indexes for fast geospatial path-based comparisons.
This is a complex structure with the following children:
geospatial-path-index
Path value geospatial index. Path leaf content has point value.
This is a complex structure with the following children:
path-expression
The path expression.
For example:/prefix1:locname1/prefix2:locname2...
coordinate-system
A coordinate system name.
point-format
The general format of the point.
range-value-positions
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
Allow ingestion of documents that do not have matching type of data.
geospatial-region-path-indexes
Indexes for fast geospatial region comparisons.
This is a complex structure with the following children:
geospatial-region-path-index
Path value geospatial region index. Path leaf content contains the region.
This is a complex structure with the following children:
path-expression
The path expression.
For example:/prefix1:locname1/prefix2:locname2...
coordinate-system
A coordinate system name.
units
Indicates which unit of measure to use for distance.
geohash-precision
An integer amount indicating the precision of geohashes used in a geospatial region index.
invalid-values
Allow ingestion of documents that do not have matching type of data.
default-rulesets
The default rulesets configuration.
This is a complex structure with the following children:
default-ruleset
Configuration for a single default ruleset.
This is a complex structure with the following children:
location
A ruleset location.
database-replication
Database replication configuration.
This is a complex structure with the following children:
foreign-replicas
Foreign replicas of this database.
This is a complex structure with the following children:
foreign-replica
Foreign replica of this database.
This is a complex structure with the following children:
foreign-cluster-name
A foreign cluster id.
foreign-database-name
A foreign database id.
connect-forests-by-name
Automatically connect local forests with foreign forests of the same name.
lag-limit
The maximum transaction journal lag to the foreign database.
replication-enabled
Whether replication is enabled for this replica.
queue-size
The size of the queue of journal frames that the replica has not
yet acknowledged.
foreign-master
Foreign replica of this database.
This is a complex structure with the following children:
foreign-cluster-name
A foreign cluster id.
foreign-database-name
A foreign database id.
connect-forests-by-name
Automatically connect local forests with foreign forests of the same name.
database-references
Cluster of clusters configuration.
This is a complex structure with the following children:
database-reference
Foreign database.
This is a complex structure with the following children:
reference-cluster-name
A foreign cluster id.
reference-database-name
A foreign database id.
rebalancer-enable
Enable automatic rebalancing after configuration changes.
rebalancer-throttle
Larger numbers mean work harder at rebalancing.
assignment-policy
The policy to use for assignment and rebalancing.
This is a complex structure with the following children:
assignment-policy-name
What policy to use for assignment and rebalancing.
partition-key
The partition key of the range assignment policy.
This is a complex structure with the following children:
cts:base-reference
lower-bound-included
If this is true, ranges on all forests in this database include the
lower bound but not the upper bound (i.e., [lower-bound, upper-bound));
if this is false, ranges on all forests include the upper bound
but not the lower bound (i.e., (lower-bound, upper-bound]).
default-partition
If a document does not match any queries in all the partitions,
it will be inserted into the default-partition.
shutdown-on-storage-failure
Enable automatic shutdown after storage failure.
storage-failure-timeout
The storeage failure timeout, in seconds.
